home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 April: Mac OS SDK / Dev.CD Apr 99 SDK1.toast / Development Kits / Interfaces&Libraries / Universal / Interfaces / AIncludes / QD3DStorage.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  9.2 KB  |  326 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3DStorage.a
  3. ;
  4. ;    Contains:    Abstraction to deal with various types of stream-based storage devices        
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.4
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__QD3DSTORAGE__') = 'UNDEFINED' THEN
  18. __QD3DSTORAGE__ SET 1
  19.  
  20.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  21.     include 'QD3D.a'
  22.     ENDIF
  23.  
  24.     IF TARGET_OS_MAC THEN
  25.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  26.     include 'MacTypes.a'
  27.     ENDIF
  28.     IF &TYPE('__FILES__') = 'UNDEFINED' THEN
  29.     include 'Files.a'
  30.     ENDIF
  31.     ENDIF    ; TARGET_OS_MAC
  32. ; ******************************************************************************
  33. ; **                                                                             **
  34. ; **                                Storage Routines                             **
  35. ; **                                                                             **
  36. ; ****************************************************************************
  37.  
  38. ;
  39. ; extern TQ3ObjectType Q3Storage_GetType(TQ3StorageObject storage)
  40. ;
  41.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  42.         IMPORT_CFM_FUNCTION Q3Storage_GetType
  43.     ENDIF
  44.  
  45. ;
  46. ; extern TQ3Status Q3Storage_GetSize(TQ3StorageObject storage, unsigned long *size)
  47. ;
  48.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  49.         IMPORT_CFM_FUNCTION Q3Storage_GetSize
  50.     ENDIF
  51.  
  52. ;  
  53. ; *    Reads "dataSize" bytes starting at offset in storage, copying into data. 
  54. ; *    sizeRead returns the number of bytes filled in. 
  55. ; *    
  56. ; *    You may assume if *sizeRead < dataSize, then EOF is at offset + *sizeRead
  57. ; 
  58.  
  59. ;
  60. ; extern TQ3Status Q3Storage_GetData(TQ3StorageObject storage, unsigned long offset, unsigned long dataSize, unsigned char *data, unsigned long *sizeRead)
  61. ;
  62.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  63.         IMPORT_CFM_FUNCTION Q3Storage_GetData
  64.     ENDIF
  65.  
  66. ;  
  67. ; *    Write "dataSize" bytes starting at offset in storage, copying from data. 
  68. ; *    sizeWritten returns the number of bytes filled in. 
  69. ; *    
  70. ; *    You may assume if *sizeRead < dataSize, then EOF is at offset + *sizeWritten
  71. ; 
  72.  
  73. ;
  74. ; extern TQ3Status Q3Storage_SetData(TQ3StorageObject storage, unsigned long offset, unsigned long dataSize, const unsigned char *data, unsigned long *sizeWritten)
  75. ;
  76.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  77.         IMPORT_CFM_FUNCTION Q3Storage_SetData
  78.     ENDIF
  79.  
  80. ; ******************************************************************************
  81. ; **                                                                             **
  82. ; **                             Memory Storage Prototypes                         **
  83. ; **                                                                             **
  84. ; ****************************************************************************
  85.  
  86. ;
  87. ; extern TQ3ObjectType Q3MemoryStorage_GetType(TQ3StorageObject storage)
  88. ;
  89.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  90.         IMPORT_CFM_FUNCTION Q3MemoryStorage_GetType
  91.     ENDIF
  92.  
  93. ; 
  94. ; * These calls COPY the buffer into QD3D space
  95. ; 
  96.  
  97. ;
  98. ; extern TQ3StorageObject Q3MemoryStorage_New(const unsigned char *buffer, unsigned long validSize)
  99. ;
  100.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  101.         IMPORT_CFM_FUNCTION Q3MemoryStorage_New
  102.     ENDIF
  103.  
  104. ;
  105. ; extern TQ3Status Q3MemoryStorage_Set(TQ3StorageObject storage, const unsigned char *buffer, unsigned long validSize)
  106. ;
  107.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  108.         IMPORT_CFM_FUNCTION Q3MemoryStorage_Set
  109.     ENDIF
  110.  
  111. ; 
  112. ; * These calls use the pointer given - you must dispose it when you're through
  113. ; 
  114.  
  115. ;
  116. ; extern TQ3StorageObject Q3MemoryStorage_NewBuffer(unsigned char *buffer, unsigned long validSize, unsigned long bufferSize)
  117. ;
  118.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  119.         IMPORT_CFM_FUNCTION Q3MemoryStorage_NewBuffer
  120.     ENDIF
  121.  
  122. ;
  123. ; extern TQ3Status Q3MemoryStorage_SetBuffer(TQ3StorageObject storage, unsigned char *buffer, unsigned long validSize, unsigned long bufferSize)
  124. ;
  125.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  126.         IMPORT_CFM_FUNCTION Q3MemoryStorage_SetBuffer
  127.     ENDIF
  128.  
  129. ;
  130. ; extern TQ3Status Q3MemoryStorage_GetBuffer(TQ3StorageObject storage, unsigned char **buffer, unsigned long *validSize, unsigned long *bufferSize)
  131. ;
  132.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  133.         IMPORT_CFM_FUNCTION Q3MemoryStorage_GetBuffer
  134.     ENDIF
  135.  
  136.     IF TARGET_OS_MAC THEN
  137. ; ******************************************************************************
  138. ; **                                                                             **
  139. ; **                                Macintosh Handles Prototypes                 **
  140. ; **                                                                             **
  141. ; ****************************************************************************
  142.  
  143. ;  Handle Storage is a subclass of Memory Storage 
  144. ;
  145. ; extern TQ3StorageObject Q3HandleStorage_New(Handle handle, unsigned long validSize)
  146. ;
  147.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  148.         IMPORT_CFM_FUNCTION Q3HandleStorage_New
  149.     ENDIF
  150.  
  151. ;
  152. ; extern TQ3Status Q3HandleStorage_Set(TQ3StorageObject storage, Handle handle, unsigned long validSize)
  153. ;
  154.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  155.         IMPORT_CFM_FUNCTION Q3HandleStorage_Set
  156.     ENDIF
  157.  
  158. ;
  159. ; extern TQ3Status Q3HandleStorage_Get(TQ3StorageObject storage, Handle *handle, unsigned long *validSize)
  160. ;
  161.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  162.         IMPORT_CFM_FUNCTION Q3HandleStorage_Get
  163.     ENDIF
  164.  
  165. ; ******************************************************************************
  166. ; **                                                                             **
  167. ; **                                Macintosh Storage Prototypes                 **
  168. ; **                                                                             **
  169. ; ****************************************************************************
  170.  
  171. ;
  172. ; extern TQ3StorageObject Q3MacintoshStorage_New(short fsRefNum)
  173. ;
  174.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  175.         IMPORT_CFM_FUNCTION Q3MacintoshStorage_New
  176.     ENDIF
  177.  
  178. ;  Note: This storage is assumed open 
  179. ;
  180. ; extern TQ3Status Q3MacintoshStorage_Set(TQ3StorageObject storage, short fsRefNum)
  181. ;
  182.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  183.         IMPORT_CFM_FUNCTION Q3MacintoshStorage_Set
  184.     ENDIF
  185.  
  186. ;
  187. ; extern TQ3Status Q3MacintoshStorage_Get(TQ3StorageObject storage, short *fsRefNum)
  188. ;
  189.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  190.         IMPORT_CFM_FUNCTION Q3MacintoshStorage_Get
  191.     ENDIF
  192.  
  193. ;
  194. ; extern TQ3ObjectType Q3MacintoshStorage_GetType(TQ3StorageObject storage)
  195. ;
  196.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  197.         IMPORT_CFM_FUNCTION Q3MacintoshStorage_GetType
  198.     ENDIF
  199.  
  200.  
  201. ; ******************************************************************************
  202. ; **                                                                             **
  203. ; **                            Macintosh FSSpec Storage Prototypes                 **
  204. ; **                                                                             **
  205. ; ****************************************************************************
  206.  
  207. ;
  208. ; extern TQ3StorageObject Q3FSSpecStorage_New(const FSSpec *fs)
  209. ;
  210.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  211.         IMPORT_CFM_FUNCTION Q3FSSpecStorage_New
  212.     ENDIF
  213.  
  214. ;
  215. ; extern TQ3Status Q3FSSpecStorage_Set(TQ3StorageObject storage, const FSSpec *fs)
  216. ;
  217.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  218.         IMPORT_CFM_FUNCTION Q3FSSpecStorage_Set
  219.     ENDIF
  220.  
  221. ;
  222. ; extern TQ3Status Q3FSSpecStorage_Get(TQ3StorageObject storage, FSSpec *fs)
  223. ;
  224.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  225.         IMPORT_CFM_FUNCTION Q3FSSpecStorage_Get
  226.     ENDIF
  227.  
  228.     ENDIF    ; TARGET_OS_MAC
  229.     IF TARGET_OS_WIN32 THEN
  230. ; ******************************************************************************
  231. ; **                                                                             **
  232. ; **                            Win32 HANDLE Storage Prototypes                     **
  233. ; **                                                                             **
  234. ; ****************************************************************************
  235.  
  236. ;
  237. ; extern TQ3StorageObject Q3Win32Storage_New(HANDLE hFile)
  238. ;
  239.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  240.         IMPORT_CFM_FUNCTION Q3Win32Storage_New
  241.     ENDIF
  242.  
  243. ;
  244. ; extern TQ3Status Q3Win32Storage_Set(TQ3StorageObject storage, HANDLE hFile)
  245. ;
  246.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  247.         IMPORT_CFM_FUNCTION Q3Win32Storage_Set
  248.     ENDIF
  249.  
  250. ;
  251. ; extern TQ3Status Q3Win32Storage_Get(TQ3StorageObject storage, HANDLE *hFile)
  252. ;
  253.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  254.         IMPORT_CFM_FUNCTION Q3Win32Storage_Get
  255.     ENDIF
  256.  
  257.     ENDIF    ; TARGET_OS_WIN32
  258.  
  259. ; ******************************************************************************
  260. ; **                                                                             **
  261. ; **                                    Unix Prototypes                             **
  262. ; **                                                                             **
  263. ; ****************************************************************************
  264.  
  265. ;
  266. ; extern TQ3StorageObject Q3UnixStorage_New(FILE *storage)
  267. ;
  268.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  269.         IMPORT_CFM_FUNCTION Q3UnixStorage_New
  270.     ENDIF
  271.  
  272. ;
  273. ; extern TQ3Status Q3UnixStorage_Set(TQ3StorageObject storage, FILE *stdFile)
  274. ;
  275.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  276.         IMPORT_CFM_FUNCTION Q3UnixStorage_Set
  277.     ENDIF
  278.  
  279. ;
  280. ; extern TQ3Status Q3UnixStorage_Get(TQ3StorageObject storage, FILE **stdFile)
  281. ;
  282.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  283.         IMPORT_CFM_FUNCTION Q3UnixStorage_Get
  284.     ENDIF
  285.  
  286. ;
  287. ; extern TQ3ObjectType Q3UnixStorage_GetType(TQ3StorageObject storage)
  288. ;
  289.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  290.         IMPORT_CFM_FUNCTION Q3UnixStorage_GetType
  291.     ENDIF
  292.  
  293. ; ******************************************************************************
  294. ; **                                                                             **
  295. ; **                                Unix Path Prototypes                         **
  296. ; **                                                                             **
  297. ; ****************************************************************************
  298.  
  299. ;
  300. ; extern TQ3StorageObject Q3UnixPathStorage_New(const char *pathName)
  301. ;
  302.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  303.         IMPORT_CFM_FUNCTION Q3UnixPathStorage_New
  304.     ENDIF
  305.  
  306. ;  C string 
  307. ;
  308. ; extern TQ3Status Q3UnixPathStorage_Set(TQ3StorageObject storage, const char *pathName)
  309. ;
  310.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  311.         IMPORT_CFM_FUNCTION Q3UnixPathStorage_Set
  312.     ENDIF
  313.  
  314. ;  C string 
  315. ;
  316. ; extern TQ3Status Q3UnixPathStorage_Get(TQ3StorageObject storage, char *pathName)
  317. ;
  318.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  319.         IMPORT_CFM_FUNCTION Q3UnixPathStorage_Get
  320.     ENDIF
  321.  
  322. ;  pathName is a buffer 
  323.  
  324.     ENDIF ; __QD3DSTORAGE__ 
  325.  
  326.